<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>VectSharp: VectSharp.Filters.ConvolutionFilter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="Doxy.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectlogo"><img alt="Logo" src="icon.svg"/></td>
  <td id="projectalign">
   <div id="projectname">VectSharp<span id="projectnumber">&#160;2.6.1</span>
   </div>
   <div id="projectbrief">A light library for C# vector graphics</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('class_vect_sharp_1_1_filters_1_1_convolution_filter.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_vect_sharp_1_1_filters_1_1_convolution_filter-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">VectSharp.Filters.ConvolutionFilter Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Represents a filter that applies a matrix convolution to the image.   
 <a href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for VectSharp.Filters.ConvolutionFilter:</div>
<div class="dyncontent">
<div class="center"><img src="class_vect_sharp_1_1_filters_1_1_convolution_filter__inherit__graph.png" border="0" usemap="#a_vect_sharp_8_filters_8_convolution_filter_inherit__map" alt="Inheritance graph"/></div>
<map name="a_vect_sharp_8_filters_8_convolution_filter_inherit__map" id="a_vect_sharp_8_filters_8_convolution_filter_inherit__map">
<area shape="rect" title="Represents a filter that applies a matrix convolution to the image." alt="" coords="5,152,201,192"/>
<area shape="rect" href="interface_vect_sharp_1_1_filters_1_1_i_location_invariant_filter.html" title="Represents a filter that can be applied to an image regardless of its location on the graphics surfac..." alt="" coords="26,79,181,104"/>
<area shape="rect" href="interface_vect_sharp_1_1_filters_1_1_i_filter.html" title="Represents a filter. Do not implement this interface directly; instead, implement ILocationInvariantF..." alt="" coords="76,5,131,31"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a73b327812cc43052706a859db30ad9cd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#a73b327812cc43052706a859db30ad9cd">ConvolutionFilter</a> (double[,] kernel, double scale, bool preserveAlpha=true, double normalisation=1, double bias=0)</td></tr>
<tr class="memdesc:a73b327812cc43052706a859db30ad9cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html" title="Represents a filter that applies a matrix convolution to the image.">ConvolutionFilter</a> with the specified parameters.   <a href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#a73b327812cc43052706a859db30ad9cd">More...</a><br /></td></tr>
<tr class="separator:a73b327812cc43052706a859db30ad9cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45c5f133d8c3c1a976c9eeb3e1c8178d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_vect_sharp_1_1_raster_image.html">RasterImage</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#a45c5f133d8c3c1a976c9eeb3e1c8178d">Filter</a> (<a class="el" href="class_vect_sharp_1_1_raster_image.html">RasterImage</a> image, double scale)</td></tr>
<tr class="memdesc:a45c5f133d8c3c1a976c9eeb3e1c8178d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Applies the filter to a <a class="el" href="class_vect_sharp_1_1_raster_image.html" title="Represents a raster image, created from raw pixel data. Consider using the derived classes included i...">RasterImage</a>. <dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">image</td><td>The <a class="el" href="class_vect_sharp_1_1_raster_image.html" title="Represents a raster image, created from raw pixel data. Consider using the derived classes included i...">RasterImage</a> to which the filter will be applied.</td></tr>
    <tr><td class="paramname">scale</td><td>The scale of the image with respect to the filter.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="class_vect_sharp_1_1_raster_image.html" title="Represents a raster image, created from raw pixel data. Consider using the derived classes included i...">RasterImage</a> containing the filtered image. The source <em>image</em>  is left unaltered.</dd></dl>
  <a href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#a45c5f133d8c3c1a976c9eeb3e1c8178d">More...</a><br /></td></tr>
<tr class="separator:a45c5f133d8c3c1a976c9eeb3e1c8178d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05ca188021f41359baddc3d61cce5bc9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vect_sharp_1_1_raster_image.html">RasterImage</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_vect_sharp_1_1_filters_1_1_i_location_invariant_filter.html#a05ca188021f41359baddc3d61cce5bc9">Filter</a> (<a class="el" href="class_vect_sharp_1_1_raster_image.html">RasterImage</a> image, double scale)</td></tr>
<tr class="memdesc:a05ca188021f41359baddc3d61cce5bc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Applies the filter to a <a class="el" href="class_vect_sharp_1_1_raster_image.html" title="Represents a raster image, created from raw pixel data. Consider using the derived classes included i...">RasterImage</a>.   <a href="interface_vect_sharp_1_1_filters_1_1_i_location_invariant_filter.html#a05ca188021f41359baddc3d61cce5bc9">More...</a><br /></td></tr>
<tr class="separator:a05ca188021f41359baddc3d61cce5bc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="properties" name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a32d973bf7389f4ac07d68ca9cf2a4dbc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_vect_sharp_1_1_point.html">Point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#a32d973bf7389f4ac07d68ca9cf2a4dbc">TopLeftMargin</a><code> [get]</code></td></tr>
<tr class="memdesc:a32d973bf7389f4ac07d68ca9cf2a4dbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines how much the area of the filter's subject should be expanded on the top-left to accommodate the results of the filter.   <a href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#a32d973bf7389f4ac07d68ca9cf2a4dbc">More...</a><br /></td></tr>
<tr class="separator:a32d973bf7389f4ac07d68ca9cf2a4dbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade808cf103a8c230dfa7d04440853b2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_vect_sharp_1_1_point.html">Point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#ade808cf103a8c230dfa7d04440853b2b">BottomRightMargin</a><code> [get]</code></td></tr>
<tr class="memdesc:ade808cf103a8c230dfa7d04440853b2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines how much the area of the filter's subject should be expanded on the bottom-right to accommodate the results of the filter.   <a href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#ade808cf103a8c230dfa7d04440853b2b">More...</a><br /></td></tr>
<tr class="separator:ade808cf103a8c230dfa7d04440853b2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84aa7dae990d0e74ec7403304fbbb298"><td class="memItemLeft" align="right" valign="top">virtual double[,]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#a84aa7dae990d0e74ec7403304fbbb298">Kernel</a><code> [get]</code></td></tr>
<tr class="memdesc:a84aa7dae990d0e74ec7403304fbbb298"><td class="mdescLeft">&#160;</td><td class="mdescRight">The kernel of the <a class="el" href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html" title="Represents a filter that applies a matrix convolution to the image.">ConvolutionFilter</a>. The dimensions of this matrix should all be odd numbers. The larger the kernel, the worse the performance.   <a href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#a84aa7dae990d0e74ec7403304fbbb298">More...</a><br /></td></tr>
<tr class="separator:a84aa7dae990d0e74ec7403304fbbb298"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f2be240a6de3ec430e6b47cb22c3a31"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#a4f2be240a6de3ec430e6b47cb22c3a31">Normalisation</a> = 1<code> [get]</code></td></tr>
<tr class="memdesc:a4f2be240a6de3ec430e6b47cb22c3a31"><td class="mdescLeft">&#160;</td><td class="mdescRight">The normalisation value that is applies to the kernel.   <a href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#a4f2be240a6de3ec430e6b47cb22c3a31">More...</a><br /></td></tr>
<tr class="separator:a4f2be240a6de3ec430e6b47cb22c3a31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c83462414bf7df2ae2d2a957dbfbfc8"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#a8c83462414bf7df2ae2d2a957dbfbfc8">Bias</a> = 0<code> [get]</code></td></tr>
<tr class="memdesc:a8c83462414bf7df2ae2d2a957dbfbfc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The bias value that is added to every colour component when the filter is applied.   <a href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#a8c83462414bf7df2ae2d2a957dbfbfc8">More...</a><br /></td></tr>
<tr class="separator:a8c83462414bf7df2ae2d2a957dbfbfc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8328d79387cab9e761d82eb5b63425db"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#a8328d79387cab9e761d82eb5b63425db">Scale</a><code> [get]</code></td></tr>
<tr class="memdesc:a8328d79387cab9e761d82eb5b63425db"><td class="mdescLeft">&#160;</td><td class="mdescRight">The scale relating the size of the kernel to graphics units.   <a href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#a8328d79387cab9e761d82eb5b63425db">More...</a><br /></td></tr>
<tr class="separator:a8328d79387cab9e761d82eb5b63425db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab32f045d8dfdef1dd0dc1647ef4eac99"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#ab32f045d8dfdef1dd0dc1647ef4eac99">PreserveAlpha</a> = true<code> [get]</code></td></tr>
<tr class="memdesc:ab32f045d8dfdef1dd0dc1647ef4eac99"><td class="mdescLeft">&#160;</td><td class="mdescRight">If this is <code>true</code>, the alpha value of the input pixels is preserved. Otherwise, the alpha channel is subject to the same convolution process as the other colour components.   <a href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html#ab32f045d8dfdef1dd0dc1647ef4eac99">More...</a><br /></td></tr>
<tr class="separator:ab32f045d8dfdef1dd0dc1647ef4eac99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header properties_interface_vect_sharp_1_1_filters_1_1_i_filter"><td colspan="2" onclick="javascript:toggleInherit('properties_interface_vect_sharp_1_1_filters_1_1_i_filter')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="interface_vect_sharp_1_1_filters_1_1_i_filter.html">VectSharp.Filters.IFilter</a></td></tr>
<tr class="memitem:a212ac6130ecf7a68d6dfcd0a2cf35a61 inherit properties_interface_vect_sharp_1_1_filters_1_1_i_filter"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_vect_sharp_1_1_point.html">Point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_vect_sharp_1_1_filters_1_1_i_filter.html#a212ac6130ecf7a68d6dfcd0a2cf35a61">TopLeftMargin</a><code> [get]</code></td></tr>
<tr class="memdesc:a212ac6130ecf7a68d6dfcd0a2cf35a61 inherit properties_interface_vect_sharp_1_1_filters_1_1_i_filter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines how much the area of the filter's subject should be expanded on the top-left to accommodate the results of the filter.   <a href="interface_vect_sharp_1_1_filters_1_1_i_filter.html#a212ac6130ecf7a68d6dfcd0a2cf35a61">More...</a><br /></td></tr>
<tr class="separator:a212ac6130ecf7a68d6dfcd0a2cf35a61 inherit properties_interface_vect_sharp_1_1_filters_1_1_i_filter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab006d719ef2f17f3ccd5d0641ece381e inherit properties_interface_vect_sharp_1_1_filters_1_1_i_filter"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_vect_sharp_1_1_point.html">Point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_vect_sharp_1_1_filters_1_1_i_filter.html#ab006d719ef2f17f3ccd5d0641ece381e">BottomRightMargin</a><code> [get]</code></td></tr>
<tr class="memdesc:ab006d719ef2f17f3ccd5d0641ece381e inherit properties_interface_vect_sharp_1_1_filters_1_1_i_filter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines how much the area of the filter's subject should be expanded on the bottom-right to accommodate the results of the filter.   <a href="interface_vect_sharp_1_1_filters_1_1_i_filter.html#ab006d719ef2f17f3ccd5d0641ece381e">More...</a><br /></td></tr>
<tr class="separator:ab006d719ef2f17f3ccd5d0641ece381e inherit properties_interface_vect_sharp_1_1_filters_1_1_i_filter"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Represents a filter that applies a matrix convolution to the image.  </p>

<p class="definition">Definition at line <a class="el" href="_convolution_filter_8cs_source.html#l00027">27</a> of file <a class="el" href="_convolution_filter_8cs_source.html">ConvolutionFilter.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a73b327812cc43052706a859db30ad9cd" name="a73b327812cc43052706a859db30ad9cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73b327812cc43052706a859db30ad9cd">&#9670;&#160;</a></span>ConvolutionFilter()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">VectSharp.Filters.ConvolutionFilter.ConvolutionFilter </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>kernel</em>[,], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>scale</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>preserveAlpha</em> = <code>true</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>normalisation</em> = <code>1</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>bias</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a new <a class="el" href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html" title="Represents a filter that applies a matrix convolution to the image.">ConvolutionFilter</a> with the specified parameters.  </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">kernel</td><td>The kernel of the <a class="el" href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html" title="Represents a filter that applies a matrix convolution to the image.">ConvolutionFilter</a>. The dimensions of this matrix should all be odd numbers. The larger the kernel, the worse the performance.</td></tr>
    <tr><td class="paramname">scale</td><td>The scale relating the size of the kernel to graphics units.</td></tr>
    <tr><td class="paramname">preserveAlpha</td><td>If this is <code>true</code>, the alpha value of the input pixels is preserved. Otherwise, the alpha channel is subject to the same convolution process as the other colour components.</td></tr>
    <tr><td class="paramname">normalisation</td><td>The normalisation value that is applies to the kernel.</td></tr>
    <tr><td class="paramname">bias</td><td>The bias value that is added to every colour component when the filter is applied.</td></tr>
  </table>
  </dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">ArgumentException</td><td>This exception is thrown when the kernel dimensions are not odd numbers.</td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="_convolution_filter_8cs_source.html#l00068">68</a> of file <a class="el" href="_convolution_filter_8cs_source.html">ConvolutionFilter.cs</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a45c5f133d8c3c1a976c9eeb3e1c8178d" name="a45c5f133d8c3c1a976c9eeb3e1c8178d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45c5f133d8c3c1a976c9eeb3e1c8178d">&#9670;&#160;</a></span>Filter()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="class_vect_sharp_1_1_raster_image.html">RasterImage</a> VectSharp.Filters.ConvolutionFilter.Filter </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_vect_sharp_1_1_raster_image.html">RasterImage</a>&#160;</td>
          <td class="paramname"><em>image</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>scale</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Applies the filter to a <a class="el" href="class_vect_sharp_1_1_raster_image.html" title="Represents a raster image, created from raw pixel data. Consider using the derived classes included i...">RasterImage</a>. <dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">image</td><td>The <a class="el" href="class_vect_sharp_1_1_raster_image.html" title="Represents a raster image, created from raw pixel data. Consider using the derived classes included i...">RasterImage</a> to which the filter will be applied.</td></tr>
    <tr><td class="paramname">scale</td><td>The scale of the image with respect to the filter.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="class_vect_sharp_1_1_raster_image.html" title="Represents a raster image, created from raw pixel data. Consider using the derived classes included i...">RasterImage</a> containing the filtered image. The source <em>image</em>  is left unaltered.</dd></dl>
 </p>

<p>Implements <a class="el" href="interface_vect_sharp_1_1_filters_1_1_i_location_invariant_filter.html#a05ca188021f41359baddc3d61cce5bc9">VectSharp.Filters.ILocationInvariantFilter</a>.</p>

<p class="definition">Definition at line <a class="el" href="_convolution_filter_8cs_source.html#l00090">90</a> of file <a class="el" href="_convolution_filter_8cs_source.html">ConvolutionFilter.cs</a>.</p>

</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="a8c83462414bf7df2ae2d2a957dbfbfc8" name="a8c83462414bf7df2ae2d2a957dbfbfc8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c83462414bf7df2ae2d2a957dbfbfc8">&#9670;&#160;</a></span>Bias</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual double VectSharp.Filters.ConvolutionFilter.Bias = 0</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The bias value that is added to every colour component when the filter is applied.  </p>

<p class="definition">Definition at line <a class="el" href="_convolution_filter_8cs_source.html#l00047">47</a> of file <a class="el" href="_convolution_filter_8cs_source.html">ConvolutionFilter.cs</a>.</p>

</div>
</div>
<a id="ade808cf103a8c230dfa7d04440853b2b" name="ade808cf103a8c230dfa7d04440853b2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade808cf103a8c230dfa7d04440853b2b">&#9670;&#160;</a></span>BottomRightMargin</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_vect_sharp_1_1_point.html">Point</a> VectSharp.Filters.ConvolutionFilter.BottomRightMargin</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Determines how much the area of the filter's subject should be expanded on the bottom-right to accommodate the results of the filter.  </p>

<p>Implements <a class="el" href="interface_vect_sharp_1_1_filters_1_1_i_filter.html#ab006d719ef2f17f3ccd5d0641ece381e">VectSharp.Filters.IFilter</a>.</p>

<p class="definition">Definition at line <a class="el" href="_convolution_filter_8cs_source.html#l00032">32</a> of file <a class="el" href="_convolution_filter_8cs_source.html">ConvolutionFilter.cs</a>.</p>

</div>
</div>
<a id="a84aa7dae990d0e74ec7403304fbbb298" name="a84aa7dae990d0e74ec7403304fbbb298"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84aa7dae990d0e74ec7403304fbbb298">&#9670;&#160;</a></span>Kernel</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual double [,] VectSharp.Filters.ConvolutionFilter.Kernel</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The kernel of the <a class="el" href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html" title="Represents a filter that applies a matrix convolution to the image.">ConvolutionFilter</a>. The dimensions of this matrix should all be odd numbers. The larger the kernel, the worse the performance.  </p>

<p class="definition">Definition at line <a class="el" href="_convolution_filter_8cs_source.html#l00037">37</a> of file <a class="el" href="_convolution_filter_8cs_source.html">ConvolutionFilter.cs</a>.</p>

</div>
</div>
<a id="a4f2be240a6de3ec430e6b47cb22c3a31" name="a4f2be240a6de3ec430e6b47cb22c3a31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f2be240a6de3ec430e6b47cb22c3a31">&#9670;&#160;</a></span>Normalisation</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual double VectSharp.Filters.ConvolutionFilter.Normalisation = 1</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The normalisation value that is applies to the kernel.  </p>

<p class="definition">Definition at line <a class="el" href="_convolution_filter_8cs_source.html#l00042">42</a> of file <a class="el" href="_convolution_filter_8cs_source.html">ConvolutionFilter.cs</a>.</p>

</div>
</div>
<a id="ab32f045d8dfdef1dd0dc1647ef4eac99" name="ab32f045d8dfdef1dd0dc1647ef4eac99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab32f045d8dfdef1dd0dc1647ef4eac99">&#9670;&#160;</a></span>PreserveAlpha</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool VectSharp.Filters.ConvolutionFilter.PreserveAlpha = true</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>If this is <code>true</code>, the alpha value of the input pixels is preserved. Otherwise, the alpha channel is subject to the same convolution process as the other colour components.  </p>

<p class="definition">Definition at line <a class="el" href="_convolution_filter_8cs_source.html#l00057">57</a> of file <a class="el" href="_convolution_filter_8cs_source.html">ConvolutionFilter.cs</a>.</p>

</div>
</div>
<a id="a8328d79387cab9e761d82eb5b63425db" name="a8328d79387cab9e761d82eb5b63425db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8328d79387cab9e761d82eb5b63425db">&#9670;&#160;</a></span>Scale</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual double VectSharp.Filters.ConvolutionFilter.Scale</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The scale relating the size of the kernel to graphics units.  </p>

<p class="definition">Definition at line <a class="el" href="_convolution_filter_8cs_source.html#l00052">52</a> of file <a class="el" href="_convolution_filter_8cs_source.html">ConvolutionFilter.cs</a>.</p>

</div>
</div>
<a id="a32d973bf7389f4ac07d68ca9cf2a4dbc" name="a32d973bf7389f4ac07d68ca9cf2a4dbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32d973bf7389f4ac07d68ca9cf2a4dbc">&#9670;&#160;</a></span>TopLeftMargin</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_vect_sharp_1_1_point.html">Point</a> VectSharp.Filters.ConvolutionFilter.TopLeftMargin</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Determines how much the area of the filter's subject should be expanded on the top-left to accommodate the results of the filter.  </p>

<p>Implements <a class="el" href="interface_vect_sharp_1_1_filters_1_1_i_filter.html#a212ac6130ecf7a68d6dfcd0a2cf35a61">VectSharp.Filters.IFilter</a>.</p>

<p class="definition">Definition at line <a class="el" href="_convolution_filter_8cs_source.html#l00030">30</a> of file <a class="el" href="_convolution_filter_8cs_source.html">ConvolutionFilter.cs</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>VectSharp/Filters/<a class="el" href="_convolution_filter_8cs_source.html">ConvolutionFilter.cs</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespace_vect_sharp.html">VectSharp</a></li><li class="navelem"><a class="el" href="namespace_vect_sharp_1_1_filters.html">Filters</a></li><li class="navelem"><a class="el" href="class_vect_sharp_1_1_filters_1_1_convolution_filter.html">ConvolutionFilter</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
  </ul>
</div>
</body>
</html>
